vcTransportInStatementBase

Base class for transport in statements.

See in: Overview

Module: vcProcessModel

Parent: vcTransportStatementBase

Children: vcStartTransportInStatement, vcTransportInStatement

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
AssemblyVariableName	String	RW	Gets or sets the name of a process variable that references the assembly instance to start filling or emptying. Used in process assembly mode.
Filter	vcProductFilter	R	Gets the filter.
ProductPositionFrame	vcFrameFeature	RW	Gets or sets the position and orientation where the product instance should be placed. Must be from the same component.
ReservedProductVariableName	String	RW	Gets or sets the name of a variable containing products already reserved using Reserve Product statement. If defined, the statement will transport in those specific products.
Source	String	RW	Gets or sets the source which determines whether to use the transport system or a container.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
demoteFromCombinationFilter	vcProductFilter	None	Downgrades back to filter, filter count must have 1 or 0 filters. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is not a CombinationFilter. TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFilter	vcProductFilter	None	Upgrades current filter to combination filter. See more Returns: vcProductFilter: The modified filter. Exceptions: TypeError: When the filter is already a CombinationFilter.
replaceFrom	vcProductFilter	vcStatement statement	Sets filter from other container. See more Parameters: statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container. Returns: vcProductFilter: The modified filter. Exceptions: AttributeError: When argument is a statement without a filter container.
setFilter	vcProductFilter	vcProductFilterType filterType	Sets to specific filter. See more Parameters: filterType (vcProductFilterType): The type of filter to set to. Returns: vcProductFilter: The new filter. Exceptions: AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

Name	Parameters	Description
OnFilterChanged	None	Triggered when filter is changed.